package apidoc;

import java.sql.SQLOutput;

/**
 * 文档注释是功能级别注释, 用于说明一个类, 方法, 常量的作用
 * 文档注释可以被javadoc命令生成为手册
 * 在类上使用时, 用于说明当前类的设计功能描述
 *
 * @version 1.0             版本
 * @auther YYT              作者
 * @see java.lang.String    参考, 参见
 * @since JDK1.8            始于哪个版本
 */
public class DocDemo {
    /**
     * sayHello方法中的问候语
     */
    public static final String INFO = "你好!";

    /**
     * 为给定的用户添加问候语                   说明方法的功能
     *
     * @param name 给定用户的名字            说明参数"name"的作用
     * @return 返回含有问候语的字符串         说明返回值
     */
    public String sayHello(String name) {
        return INFO + name;
    }
}
